package online.niuma.xiaocubao.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;


/**
 * @author 一颗蛋50斤
 * IntelliJ IDEA
 */
@Configuration
@EnableSwagger2
@Profile({"dev", "test"})
public class SwaggerConfig {


    /**
     * 创建 swagger bean
     */
    @Bean
    public Docket docket() {
        // Docket 是 swagger 全局配置对象
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // swagger 扫描包配置
                // select()获取Docket中的选择器，返回ApiSelectorBuilder构造选择器，如扫描扫描包的注解
                .select()
                /*
                 * requestHandlerSelectors：请求处理选择器
                 * basePackage()：扫描指定包下的所有接口
                 * any()：扫描所有的包
                 * none()：不扫描
                 * withClassAnnotation()：扫描指定类上的注解，参数是一个注解的放射对象
                 * withMethodAnnotation()：扫描方法上的注解
                 */
                // 指定扫描器扫描的规则（断言）
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                /*
                 * pathSelectors：路径选择器，过滤路径
                 * any()：选择所有路径
                 * none()：都不选择
                 * ant()：选择指定路径
                 * regex()：正则表达式
                 */
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * swagger 文档信息
     */
    public ApiInfo apiInfo() {
        Contact contact = new Contact(
                "niuma",
                "https://niuma.online",
                "2493378918"
        );
        return new ApiInfo(
                "xiaocubao swagger api",
                "小醋包 api 文档",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<>()
        );
    }
}
